home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / shazam11.zip / README < prev    next >
Text File  |  1991-11-04  |  12KB  |  306 lines
  1.                              Welcome to SHAZAM!
  2.                              ------------------
  3.  
  4. SHAZAM opens the "readme." file and invokes F1-HELP on startup.  To stop
  5. this from happening, rename the file to something else (like "readme.txt").
  6.  
  7. Context-sensitive Help and the Technical Manual are in HyperText format,
  8. available anytime by pressing F1-Help.  Also, the Software License,
  9. How-To-Order, and BBS/Disk Library/ShareWare information are available from
  10. the primary Help Screen.
  11.  
  12. This file contains installation instructions, brief descriptions of the
  13. demostration files and last-minute information (if any).
  14.  
  15.  
  16. TABLE OF CONTENTS
  17. -----------------
  18.  1.  Update Notes
  19.  2.  Installation
  20.  3.  Operation
  21.  4.  Requirements
  22.  5.  Overview
  23.  6.  Clean-up
  24.  7.  Examples/Demos
  25.  8.  Registration
  26.  
  27.  
  28.  
  29. 1.  UPDATE NOTES:  Version 1.1
  30. ==============================
  31. Improvements, changes and fixes.
  32.  
  33. IMPROVEMENTS
  34. ------------
  35. The following improvements have been made:
  36.  
  37.  [X] Compile/Run/Shell overhead reduced to less than 6k.
  38.      ("Swap-to-disk" is now the default EXEC option)
  39.  [X] Print one or all files (within editor) to any LPT port.
  40.  
  41. FIXES
  42. -----
  43. Using the mouse to activate "F3 File|Open" may sometimes have resulted
  44. in an error message.  This is corrected.
  45.  
  46. DOWNLOAD/UPDATES
  47. ----------------
  48. Example files have been separated from the program files, to make
  49. downloading of updates faster/less redundant:
  50.  
  51.  [X] SHAZAM.ZIP  contains the program and only 3 demo *.DEF files
  52.  [X] SZDEMO.ZIP   contains 40+ more example definitions (70+ total files)
  53.  
  54.  
  55.  
  56. 2.  INSTALLATION
  57. ================
  58. Installation is pretty straightforward:
  59.  
  60.    1.  Create an \SZ sub-directory.
  61.    2.  Uncompress the files to it.
  62.    3.  Move SHAZAM.* to the \TP directory (leave all other files in \SZ).
  63.  
  64. You don't have to copy SHAZAM.* to \TP, but by doing so SHAZAM will be
  65. available to you from any other directory.  Also, the configuration (if you
  66. want to save one) is placed in a file in the program directory.
  67.  
  68. FYI:  For convenience, you may create a single program from the *.EXE and
  69.       *.VRM files:
  70.  
  71.       C:>copy /b shazam.exe + shazam.vrm        { combine files to EXE }
  72.       C:>del shazam.vrm                         { delete overlay }
  73.  
  74.  
  75.  
  76. 3.  OPERATION & SWITCHES
  77. ========================
  78.  
  79. SYNTAX:  C:>shazam [ filespec ] [ /switches ]
  80.  
  81. The program allows interactive use or wildcard command-line operation.
  82. If no filespec is given, you get interactive mode.  Switches affect
  83. both modes.  To see a list of command-line switches, use "/?" or "?".
  84.  
  85.  
  86. Options|ExecSwap
  87. ----------------
  88. When accessing DOS to compile, run a program, use the command-line, etc.
  89. SHAZAM can swap itself to EMS or disk.  This maximizes available memory
  90. for a sub-process, at a small cost in time required for the swap.
  91.  
  92. Default operation is ON; SHAZAM will swap itself to EMS or disk.  You may
  93. deactivate it from the Options|Change dialog box.
  94.  
  95. NOTE:  The swap feature uses EXECSWAP, by TurboPower software.  This
  96.        code is available on CompuServe, in the PCVENB forum library.
  97.  
  98.  
  99.  
  100. 4.  REQUIREMENTS
  101. ================
  102.  √  Turbo Pascal 6.0 and Turbo Vision
  103.  √  PATH= statement must contain  x:\TP  (directory where TPC.EXE is)
  104.  √  TPC and TVHC programs; HELPFILE unit directory in TPC.CFG
  105.  
  106.  
  107. TPC, TVHC & HELPFILE
  108. --------------------
  109. SHAZAM uses the following programs/units:
  110.  
  111.    [X] TPC.EXE, the Turbo Pascal command-line Compiler   (x:\TP)
  112.    [X] All Turbo Vision units                            (x:\TP\TVISION)
  113.    [X] TVHC.EXE, the Turbo Vision Help Compiler          (x:\TP\TVDEMOS)
  114.    [X] HELPFILE.TPU                                      (x:\TP\TVDEMOS)
  115.  
  116. TPC.EXE and TVHC.EXE must be available via the PATH= environment variable,
  117. or the program will HALT and display an error message.
  118.  
  119. Your TPC.CFG file MUST contain the Turbo Vision directories.
  120.  
  121. Also, HELPFILE.TPU must be available via:
  122.  () TPC.CFG, or
  123.  ( ) be in the current directory
  124.  
  125. FYI:  In addition to calling the Help Compiler, SHAZAM also creates
  126.       and/or updates Help Text for TVHC.
  127.  
  128. FYI:  GADGETS.TPU is used by some example *.DEF programs.
  129.  
  130.  
  131. IDE & DLGDSN
  132. ------------
  133. Both the IDE (Alt-U) and DLGDSN (Alt-D) may be accessed directly from
  134. SHAZAM, if on the PATH.  DLGDSN (Dialogbox Design) is recommended; it
  135. is available on-line (CompuServe) in the BPROGA forum.
  136.  
  137.  
  138.  
  139. 5.  OVERVIEW
  140. ============
  141. SHAZAM generates complete TApplications, including help, so you can test
  142. the look & feel of your visual shell.
  143.  
  144. You can generate, compile and run directly from SHAZAM.
  145.  
  146. The Turbo Vision objects provide you with a set of "bones", around which
  147. you add the "meat" of your application.  With SHAZAM, you change the
  148. skeleton to make different animals.  This lets you concentrate on "fleshing
  149. out" your program, rather than writing and debugging user-interface code.
  150. (OK, OK, enough with the analogies already...)
  151.  
  152. MenuBars and Hints, StatusLines, etc. are composed one line at a time, in a
  153. definition (*.DEF) file.  Most of the example files (DEMO*.DEF) are
  154. commented; you can generate or compile all of 'em from the command-line:
  155.  
  156.    Command           Action                Disk space       12mhz/286
  157.    -------           ------                ----------       ---------
  158.    C:>shazam */x-    {code & help}         2.2 megabytes    33 min
  159.    C:>shazam */m/x-  {compile to *.EXE}    2.9 megabytes    44 min (48 w/x+)
  160.  
  161. Note the "/x-" switch; this disables ExecSwap, which gains you about
  162. 4 minutes, when doing all-at-once.
  163.  
  164. You might want to do one at a time, however, then delete generated/compiled
  165. files, 'cause doing all-at-once takes a serious chunk of disk space:
  166.  
  167.    ESTIMATE
  168.    C:>shazam */m              Files        Size
  169.    ********************************************
  170.    Program & Help (SHAZAM.*)      3       291 k
  171.    --------------------------------------------
  172.    Demo (*.DEF, *.TXT, etc)      77       251 k
  173.    ============================================
  174.    TOTAL                         80       542 k
  175.    ********************************************
  176.    TPU                           41        66 k
  177.    --------------------------------------------
  178.    HLP                           40       297 k
  179.    --------------------------------------------
  180.    Generated Code               383       1.8 M
  181.    ============================================
  182.    TOTAL                        464       2.2 M
  183.    ********************************************
  184.    EXE                           45       2.9 M
  185.    ============================================
  186.    GRAND TOTAL                  589       5.6 M
  187.    ============================================
  188.  
  189.  
  190.  
  191. 6.  CLEAN-UP
  192. ============
  193. If you're in interactive mode, you can use File|Erase.. to delete
  194. generated/compiled output.
  195.  
  196. From the command-line, you can delete all generated output by:
  197.  
  198.     C:>shazam */del              {CLEAN.BAT does this & CHKDSK too}
  199.  
  200. For each *.DEF file, SHAZAM deletes all generated files plus any compiled
  201. files (*.EXE, *.TPU, *.OVR and *.HLP).
  202.  
  203.  
  204.  
  205. 7.  EXAMPLES
  206. ============
  207. While the main purpose of SHAZAM is to provide a fast and easy way to
  208. create visual shells, you can also "activate" some or all of your
  209. shell's menu/status commands, using the "Custom Components" and
  210. "ListItem Symbols" (^^ and %%) features; the example files show both
  211. simple shells and functional programs.
  212.  
  213.    {- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  214.    ...please drop a line with your opinion of the demos!
  215.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -}
  216.  
  217. "demoSE.def" is a complete and working Turbo Vision program.
  218.    (If you rename it to "EDIT.EXE", it makes a nice replacement for the
  219.    DOS 5.0 editor and works like Windows' 3.0 SYSEDIT.  Then use LZEXE
  220.    and you've got a portable editor that's less than 60k (HLP is 13k).
  221.    This program really shows off the power of Turbo Vision.)
  222.  
  223. "demoTS.def" is the most heavily commented; it also shows off most of
  224. what SHAZAM can do for you, when writing just TApplication shells.
  225.  
  226. The "demo00.def" (zero-zero) file is deliberately empty, to demonstrate
  227. default generated elements.
  228.  
  229. The rest of the demos...
  230.  
  231.    demoX?.def - Where "X" is a NUMBER, such as demo1A.def, demo2A.def, etc.
  232.    ----------   These show stand-alone menus, like "File", "Edit", "Search",
  233.                 etc.  For simplicity's sake, these are not commented at all.
  234.  
  235.                 In A-B-C order (demo1A.def, demo1B.def, demo1C.def), they
  236.                 become more enhanced at each level:
  237.  
  238.                 demo?A.def - Simplest possible menu model
  239.                 demo?B.def - has Hints, also used to create "dummy" Help Text
  240.                 demo?C.def - has Help Text (*.TXT) files
  241.                 ---------------------------------------------
  242.                 And now for something completely different...
  243.                 ---------------------------------------------
  244.                 "create6C.BAT" uses DOS COPY to assemble a "composite"
  245.                 application from tested components, complete with Help Text.
  246.  
  247.                 Even if you modify any of the demo?C.def files, it will still 
  248.                 create new help text to add help references for your changes.
  249.  
  250.  
  251.    demoX?.def - Where "X" is a LETTER, such as demoL1.def, demoN1.def, etc.
  252.    ----------
  253.                 "C?" - Custom Component files.  Specific examples of how
  254.                        *.USE, *.INC, *.VIR and *.EVT are used for real code.
  255.                 "E?" - Editor demo.  Starts with a just a menu structure,
  256.                        then adds Custom Component files, then changes menus.
  257.                        (These are working programs, not just models.)
  258.                 "L?" - Learning files.  These show each major function
  259.                        separately.
  260.                 "N?" - Nested menu demonstrations, show how you can change
  261.                        a definition, then quickly regenerate code ("The
  262.                        Interface Game".)
  263.                 "Q?" - Quattro Pro menu models.
  264.                 "P?" - Paradox 3.0 menu models.
  265.                 "DD" - Dialogbox Design
  266.                 "SE" - System Editor (complete program, not a model)
  267.                 "SZ" - Shazam
  268.                 "TP" - IDE for a popular language/compiler...
  269.  
  270.  
  271.  
  272. 8.  REGISTRATION (ShareWare)
  273. ============================
  274. This is a fully functional program, with only a filename restriction:
  275.  
  276.    [X]  *.DEF filenames must be exactly 6 characters in length
  277.    [X]  The first 4 letters must be "DEMO" (2-character suffix allowed)
  278.  
  279. Cost is $39.00 and you get the complete version by 1st Class Mail.  Send
  280. your name, mail-address, disk-size and check or credit-card information by:
  281.  
  282.    ()  CompuServe EMAIL or Telephone, using MasterCard or Visa.
  283.    ( )  U.S. Mail, using Check, MasterCard or Visa.
  284.  
  285. Registration/Tech Support (also in "About" and "Help"):
  286.  
  287.                        Johnathan J. Stein
  288.                        Post Office Box 346
  289.                       Perrysburg, OH 43552
  290.                           419-666-7103
  291.                       CompuServe 76576,470
  292.  
  293.  
  294. {///////////////////////////////////////////////////////////////////
  295. //                           THE END                              //
  296. ////////////////////////////////////////////////////////////////////
  297. //                                                                //
  298. //                  Our Hero will return, in...                   //
  299. //                  ---------------------------                   //
  300. //                       Shazam, Part II:                         //
  301. //              "CONQUEST of the RESOURCE MONSTER!"               //
  302. //                                                                //
  303. ////////////////////////////////////////////////////////////////////
  304. //         Advance tickets sent to Registered Users of 1.x        //
  305. ///////////////////////////////////////////////////////////////////}
  306.